home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 127 / PC Guia 127.iso / Software / Produtividade / OpenOffice.org 2.0.1 / openofficeorg3.cab / popen2.py < prev    next >
Text File  |  2005-11-19  |  7KB  |  203 lines
  1. """Spawn a command with pipes to its stdin, stdout, and optionally stderr.
  2.  
  3. The normal os.popen(cmd, mode) call spawns a shell command and provides a
  4. file interface to just the input or output of the process depending on
  5. whether mode is 'r' or 'w'.  This module provides the functions popen2(cmd)
  6. and popen3(cmd) which return two or three pipes to the spawned command.
  7. """
  8.  
  9. import os
  10. import sys
  11.  
  12. __all__ = ["popen2", "popen3", "popen4"]
  13.  
  14. try:
  15.     MAXFD = os.sysconf('SC_OPEN_MAX')
  16. except (AttributeError, ValueError):
  17.     MAXFD = 256
  18.  
  19. _active = []
  20.  
  21. def _cleanup():
  22.     for inst in _active[:]:
  23.         inst.poll()
  24.  
  25. class Popen3:
  26.     """Class representing a child process.  Normally instances are created
  27.     by the factory functions popen2() and popen3()."""
  28.  
  29.     sts = -1                    # Child not completed yet
  30.  
  31.     def __init__(self, cmd, capturestderr=False, bufsize=-1):
  32.         """The parameter 'cmd' is the shell command to execute in a
  33.         sub-process.  The 'capturestderr' flag, if true, specifies that
  34.         the object should capture standard error output of the child process.
  35.         The default is false.  If the 'bufsize' parameter is specified, it
  36.         specifies the size of the I/O buffers to/from the child process."""
  37.         _cleanup()
  38.         p2cread, p2cwrite = os.pipe()
  39.         c2pread, c2pwrite = os.pipe()
  40.         if capturestderr:
  41.             errout, errin = os.pipe()
  42.         self.pid = os.fork()
  43.         if self.pid == 0:
  44.             # Child
  45.             os.dup2(p2cread, 0)
  46.             os.dup2(c2pwrite, 1)
  47.             if capturestderr:
  48.                 os.dup2(errin, 2)
  49.             self._run_child(cmd)
  50.         os.close(p2cread)
  51.         self.tochild = os.fdopen(p2cwrite, 'w', bufsize)
  52.         os.close(c2pwrite)
  53.         self.fromchild = os.fdopen(c2pread, 'r', bufsize)
  54.         if capturestderr:
  55.             os.close(errin)
  56.             self.childerr = os.fdopen(errout, 'r', bufsize)
  57.         else:
  58.             self.childerr = None
  59.         _active.append(self)
  60.  
  61.     def _run_child(self, cmd):
  62.         if isinstance(cmd, basestring):
  63.             cmd = ['/bin/sh', '-c', cmd]
  64.         for i in range(3, MAXFD):
  65.             try:
  66.                 os.close(i)
  67.             except OSError:
  68.                 pass
  69.         try:
  70.             os.execvp(cmd[0], cmd)
  71.         finally:
  72.             os._exit(1)
  73.  
  74.     def poll(self):
  75.         """Return the exit status of the child process if it has finished,
  76.         or -1 if it hasn't finished yet."""
  77.         if self.sts < 0:
  78.             try:
  79.                 pid, sts = os.waitpid(self.pid, os.WNOHANG)
  80.                 if pid == self.pid:
  81.                     self.sts = sts
  82.                     _active.remove(self)
  83.             except os.error:
  84.                 pass
  85.         return self.sts
  86.  
  87.     def wait(self):
  88.         """Wait for and return the exit status of the child process."""
  89.         if self.sts < 0:
  90.             pid, sts = os.waitpid(self.pid, 0)
  91.             if pid == self.pid:
  92.                 self.sts = sts
  93.                 _active.remove(self)
  94.         return self.sts
  95.  
  96.  
  97. class Popen4(Popen3):
  98.     childerr = None
  99.  
  100.     def __init__(self, cmd, bufsize=-1):
  101.         _cleanup()
  102.         p2cread, p2cwrite = os.pipe()
  103.         c2pread, c2pwrite = os.pipe()
  104.         self.pid = os.fork()
  105.         if self.pid == 0:
  106.             # Child
  107.             os.dup2(p2cread, 0)
  108.             os.dup2(c2pwrite, 1)
  109.             os.dup2(c2pwrite, 2)
  110.             self._run_child(cmd)
  111.         os.close(p2cread)
  112.         self.tochild = os.fdopen(p2cwrite, 'w', bufsize)
  113.         os.close(c2pwrite)
  114.         self.fromchild = os.fdopen(c2pread, 'r', bufsize)
  115.         _active.append(self)
  116.  
  117.  
  118. if sys.platform[:3] == "win" or sys.platform == "os2emx":
  119.     # Some things don't make sense on non-Unix platforms.
  120.     del Popen3, Popen4
  121.  
  122.     def popen2(cmd, bufsize=-1, mode='t'):
  123.         """Execute the shell command 'cmd' in a sub-process.  If 'bufsize' is
  124.         specified, it sets the buffer size for the I/O pipes.  The file objects
  125.         (child_stdout, child_stdin) are returned."""
  126.         w, r = os.popen2(cmd, mode, bufsize)
  127.         return r, w
  128.  
  129.     def popen3(cmd, bufsize=-1, mode='t'):
  130.         """Execute the shell command 'cmd' in a sub-process.  If 'bufsize' is
  131.         specified, it sets the buffer size for the I/O pipes.  The file objects
  132.         (child_stdout, child_stdin, child_stderr) are returned."""
  133.         w, r, e = os.popen3(cmd, mode, bufsize)
  134.         return r, w, e
  135.  
  136.     def popen4(cmd, bufsize=-1, mode='t'):
  137.         """Execute the shell command 'cmd' in a sub-process.  If 'bufsize' is
  138.         specified, it sets the buffer size for the I/O pipes.  The file objects
  139.         (child_stdout_stderr, child_stdin) are returned."""
  140.         w, r = os.popen4(cmd, mode, bufsize)
  141.         return r, w
  142. else:
  143.     def popen2(cmd, bufsize=-1, mode='t'):
  144.         """Execute the shell command 'cmd' in a sub-process.  If 'bufsize' is
  145.         specified, it sets the buffer size for the I/O pipes.  The file objects
  146.         (child_stdout, child_stdin) are returned."""
  147.         inst = Popen3(cmd, False, bufsize)
  148.         return inst.fromchild, inst.tochild
  149.  
  150.     def popen3(cmd, bufsize=-1, mode='t'):
  151.         """Execute the shell command 'cmd' in a sub-process.  If 'bufsize' is
  152.         specified, it sets the buffer size for the I/O pipes.  The file objects
  153.         (child_stdout, child_stdin, child_stderr) are returned."""
  154.         inst = Popen3(cmd, True, bufsize)
  155.         return inst.fromchild, inst.tochild, inst.childerr
  156.  
  157.     def popen4(cmd, bufsize=-1, mode='t'):
  158.         """Execute the shell command 'cmd' in a sub-process.  If 'bufsize' is
  159.         specified, it sets the buffer size for the I/O pipes.  The file objects
  160.         (child_stdout_stderr, child_stdin) are returned."""
  161.         inst = Popen4(cmd, bufsize)
  162.         return inst.fromchild, inst.tochild
  163.  
  164.     __all__.extend(["Popen3", "Popen4"])
  165.  
  166. def _test():
  167.     cmd  = "cat"
  168.     teststr = "ab cd\n"
  169.     if os.name == "nt":
  170.         cmd = "more"
  171.     # "more" doesn't act the same way across Windows flavors,
  172.     # sometimes adding an extra newline at the start or the
  173.     # end.  So we strip whitespace off both ends for comparison.
  174.     expected = teststr.strip()
  175.     print "testing popen2..."
  176.     r, w = popen2(cmd)
  177.     w.write(teststr)
  178.     w.close()
  179.     got = r.read()
  180.     if got.strip() != expected:
  181.         raise ValueError("wrote %s read %s" % (`teststr`, `got`))
  182.     print "testing popen3..."
  183.     try:
  184.         r, w, e = popen3([cmd])
  185.     except:
  186.         r, w, e = popen3(cmd)
  187.     w.write(teststr)
  188.     w.close()
  189.     got = r.read()
  190.     if got.strip() != expected:
  191.         raise ValueError("wrote %s read %s" % (`teststr`, `got`))
  192.     got = e.read()
  193.     if got:
  194.         raise ValueError("unexected %s on stderr" % `got`)
  195.     for inst in _active[:]:
  196.         inst.wait()
  197.     if _active:
  198.         raise ValueError("_active not empty")
  199.     print "All OK"
  200.  
  201. if __name__ == '__main__':
  202.     _test()
  203.